Pular para o conteúdo principal

Consulta de Documentos

A API para consulta de documentos armazenados pelo SantoID

:::info Documentação Relacionada

:::tip Nota

Os links gerados são assinados, os mesmo tem validade de 15 minutos para recuperar o documento

:::

Requisição HTTP GET​

Tipos de ConsultasExemplos
Retorno por Track/api/v1/tracks/{track}/storage Retorna todos os documentos da track específica. Ex: /api/v1/tracks/track123/storage - Retorna todos documentos da track123.
Retorno por CPF ou CNPJ/api/v1/tracks/{track}/storage/cpf-cnpj/{cpf ou cnpj} Retorna o documento da track de um CPF ou CNPJ específica. Ex: /api/v1/tracks/track123/storage/cpf-cnpj/99999999999 - Retorna da track track123 todos documentos em que encontre o CPF 999.999.999-99.
Retorno por Request ID/api/v1/tracks/{track}/storage/request_id/{request_id} Retorna o documento da track de uma request id específica. Ex: /api/v1/tracks/track123/storage/request_id/12345abcde - Retorna da track track123 o link assinado caso encontre a request id 12345abcde.
Retorno por Template ID/api/v1/tracks/{track}/storage/templates/{doc_type} Retorna todos os documentos da track por tipo de template id utilizado na extração. Ex: /api/v1/tracks/track123/storage/templates/template-builtin-cnh - Retorna da track track123 todos documentos em que utilizaram o template id template-builtin-cnh.

Exemplos de retorno por Track, Template ID, CPF e CNPJ​

:::tip Nota

Exemplo de encontrado ao menos um documento, retornarar um array de strings, cada string de um link assinado de duração de 15 minutos.

:::

[
  "link_assinado_1",
  "link_assinado_2",
  "link_assinado_3"
]

Exemplos de retorno por Request ID​

:::tip Nota

Exemplo de encontrado vai ter o retorno de uma string, sendo ela um link assinado de duração de 15 minutos

:::

"link assinado"
informação

Página para exemplos de requisições clique aqui.

Status Response Code​

Status 200​

Consulta realizada com sucesso

Status 400​

Parâmetros incorretos.

Status 404​

Nenhum documento encontrado.